home *** CD-ROM | disk | FTP | other *** search
/ Risc World 3 / Risc World 3.iso / SOFTWARE / ISSUE4 / ZAP / !Zap / Modules / !ZapPMS / !Help next >
Text File  |  2002-05-08  |  5KB  |  128 lines
  1.  
  2.                ZapPMS, a Zap syntax colouring mode
  3.                ====================================
  4.  
  5. 1.0 Features
  6. ============
  7.  
  8. This module performs syntax colouring designed for PMS documents.
  9.  
  10. Philip's Music Scribe (PMS) is a computer program for typesetting high
  11. quality music.  Demonstration versions are available from HENSA or
  12. on CD ROM as CDFS::RISC_DISC2.$.COMMERCIAL.PMS.
  13.  
  14. The module contains some enhancements to the cursor keys so that
  15. when they are used in combination with the shift key they behave in a
  16. more appropriate manner than when is in text mode.  These routines have
  17. been stolen from Martin Ebourne's C mode and are documented by him in
  18. his own directory.  Briefly they make the shift-cursor combinations
  19. pause more frequently and more intelligently step through the code.
  20. Martin has kindly given permission for his code to be used.
  21.  
  22. It also contains C mode style bracket matching.
  23.  
  24. Note that the settings for the delay (in centiseconds) may range
  25. over the even numbers only from zero to 62.
  26.  
  27. Setting this to zero turns the option off. It also defaults to off, so
  28. you will need to configured it via the mode menu before it will do
  29. anything.
  30.  
  31. Although the author welcomes correspondence concerning this mode, he
  32. makes no cliam that it is bug-free and, it is not guaranteed to perform
  33. any particular function.  It is to be used entirely at one's own risk.
  34.  
  35. This is Freeware, and may be distributed freely provided that all it is
  36. redistributed intact.  If engaging in large-scale distribution, it is
  37. requested that you contact the author before doing so to obttain his
  38. permission to do this.
  39.  
  40.  
  41. 2.0 Installation
  42. ================
  43.  
  44. Copy the module !ZapPMS application into the !Zap.Modules directory, then restart Zap.
  45.  
  46.  
  47. 3.0 Problems
  48. ============
  49.  
  50.                               Mode problems:
  51.                   ~~~~~~~~~~~~~~
  52. The bracket matching gets confused by brackets embedded in strings.
  53.  
  54.                        Syntax colouring problems:
  55.                 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  56. PMS is not an easy language to syntax colour correctly.
  57.  
  58. ZapPMS does not colour strings split across lines correctly.
  59.  
  60. Some of the colouring has been done in ignorance of the program's syntax.
  61. Comments are welcome.
  62.  
  63. If you know anything about PMS, then you can probably improve this mode
  64. by remote control by emailing tt@cryogen.com with your comments.
  65.  
  66.  
  67. 4.0 History
  68. ===========
  69.  
  70. v0.06 - (09-Feb-96)
  71.       * Commands which wrap between lines are now coloured correctly.
  72.       * The code for detecting \...\ sequences has been modified so this works
  73.         between lines.  &... sequences and ( ... ) brackets can still cause
  74.         more minor problems when wrapped, however.
  75.       * The last menu entry has been changed to only represent the '/'
  76.         character.  The other characters which were here are now represented
  77.         by the 'Foreground' colour - make sure the 'All modes' option is not
  78.         ticked when editing this.
  79.  
  80. v0.05 - (31-Jan-96)
  81.       * A minor change the ']' character is now recognised as stopping
  82.         all commands.
  83.  
  84. v0.04 - (20-Jan-96)
  85.       * Bugfix: insertions of multiple characters is no longer in
  86.         conflict with the bracket matching code.
  87.       * Bugfix: clicking on the mode menu entry leading to the
  88.         "Pause" writable menu no longer crashes Zap.
  89.  
  90. v0.03 - (17-Jan-96)
  91.       * Made the & operator inoperative in strings.  This seemed to be
  92.         inappropriate more often than it was appropriate.
  93.       * Made \...\ sequences slightly more choosy about what they enclose
  94.         to remove an observed problem.
  95.       * Removed lots of irrelevant hexadecimal number code which was
  96.         causing occasional miscolourings.
  97.       * Added more menu options for different kinds of brackets.
  98.       * Completely changed the method used to check for / ... /
  99.         sequences.  This new method may nat always get things right,
  100.         but it certainly does better than the old one in most cases.
  101.       * Sorry if the default colours are more garish than they used to be.
  102.         
  103. v0.02 - (14-Jan-96)
  104.       * Small number of changes based on a comprehensive user's wishlist.
  105.  
  106. v0.01 - (09-Jan-96)
  107.       * Very early release to essentially one person.
  108.  
  109. Enjoy
  110.  
  111.  
  112. 5.0 Contact
  113. ===========
  114.  
  115.   Any bug reports or missing commands should be sent to 
  116.   
  117.         bugs@zap.tartarus.org
  118.         
  119.   Feature requests should be directed towards
  120.   
  121.           zap-features@zap.tartarus.org
  122.  
  123.  
  124. There are a also a number of mailing lists you can subscribe to - see
  125. Zap's web pages for details:
  126.  
  127.         http://zap.tartarus.org/
  128.